org.springframework.core.codec

Class AbstractEncoder<T>

java.lang.Object

org.springframework.core.codec.AbstractEncoder<T>

All Implemented Interfaces:

Encoder<T>

Direct Known Subclasses:

AbstractSingleValueEncoder, ByteArrayEncoder, ByteBufferEncoder, CharSequenceEncoder, DataBufferEncoder, ResourceRegionEncoder

public abstract class AbstractEncoder<T>
extends java.lang.Object
implements Encoder<T>

Abstract base class for Decoder implementations.

Since:

5.0

Author:

Sebastien Deleuze, Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MimeType>	encodableMimeTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEncoder(MimeType... supportedMimeTypes)

Method Summary

Modifier and Type	Method and Description
boolean	canEncode(ResolvableType elementType, MimeType mimeType) Whether the encoder supports the given source element type and the MIME type for the output stream.
java.util.List<MimeType>	getEncodableMimeTypes() Return the list of mime types this encoder supports.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.core.codec.Encoder

encode, getContentLength

Field Detail

encodableMimeTypes

private final java.util.List<MimeType> encodableMimeTypes

Constructor Detail

AbstractEncoder

protected AbstractEncoder(MimeType... supportedMimeTypes)

Method Detail

getEncodableMimeTypes

public java.util.List<MimeType> getEncodableMimeTypes()

Description copied from interface: Encoder

Return the list of mime types this encoder supports.

Specified by:

getEncodableMimeTypes in interface Encoder<T>

canEncode

public boolean canEncode(ResolvableType elementType,
                         @Nullable
                         MimeType mimeType)

Description copied from interface: Encoder

Whether the encoder supports the given source element type and the MIME type for the output stream.

Specified by:

canEncode in interface Encoder<T>

Parameters:

elementType - the type of elements in the source stream

mimeType - the MIME type for the output stream (can be null if not specified)

Returns:

true if supported, false otherwise